Open
Conversation
Add missing gradle toolchain dependencies to the list of Java version requirements, both in CONTRIBUTING.md and mise.toml. Fix test instructions in CONTRIBUTING.md, which incorrectly state that a temporal server needs to be running during tests. Explain how to run the tests that *do* require a temporal server.
|
|
| ## Testing | ||
|
|
||
| Run a local temporal server with the [temporal CLI](https://docs.temporal.io/cli#installation): | ||
| Some tests assume you have the temporal server running, and others don't. By default, Gradle only runs the tests that don't require a server: |
Contributor
There was a problem hiding this comment.
This paragraph isn't accurate, or is at least misleading. The tests by default use the built in test server, and you can optionally run against a real server instead
|
|
||
| ```bash | ||
| ./gradlew build | ||
| USE_DOCKER_SERVICE=true ./gradlew test |
Contributor
There was a problem hiding this comment.
The environment variable name predate being able to start the Temporal server with the CLI, so docker was the main way to run the Temporal server locally, but we should probably update it now (doesn't need to be in this PR just adding some historical context)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What was changed
Updated CONTRIBUTING.md and mise.toml, adding missing gradle toolchain dependencies.
Also fixed test instructions in CONTRIBUTING.md, which incorrectly state that a temporal server needs to be running during tests. Explained how to run the tests that do require a temporal server.
Why?
The project wouldn't build when following the old instructions. The instructions were also omitting some tests that require a temporal server to be running.